DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.9.1 StructureDefinition: DAF-Immunization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-immunization

Defines constraints and extensions on the Immunization resource for use in querying and retrieving patient's immunization information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.9.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Immunization.

Summary

Mandatory: 4 elements (+4 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S1..1dateTimeVaccination administration date
... vaccineCode 1..1CodeableConceptVaccine product administered
Binding: Vaccine Administered Value Set (example)
... patient S1..1Reference(DAF-Patient)Who was immunized?
... wasNotGiven ?! I1..1booleanFlag for whether immunization was given
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... reported S1..1booleanIs this a self-reported record?
... performer S0..1Reference(U.S. Data Access Framework (DAF) Practitioner Profile | U.S. DAF Organization Profile)Who administered vaccine?
... requester S0..1Reference(U.S. Data Access Framework (DAF) Practitioner Profile | U.S. DAF Organization Profile)Who ordered vaccination?
... encounter 0..1Reference(U.S. Data Access Framework (DAF) Encounter profile)Encounter administered as part of
... manufacturer S0..1Reference(U.S. DAF Organization Profile)Vaccine Manufacturer
... location 0..1Reference(Location)Where did vaccination occur?
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Medication Route FDA Value Set (preferred)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration / non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen did reaction start?
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported S0..1booleanWas reaction self-reported?
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntWhat dose number within series?
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(U.S. DAF Organization Profile)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..1CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose TargetCodes (example)
.... doseStatus S1..1CodeableConceptDoes dose count towards immunity?
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy does does count/not count?
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

todo

This structure is derived from Immunization.

Summary

Mandatory: 4 elements (+4 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S1..1dateTimeVaccination administration date
... vaccineCode 1..1CodeableConceptVaccine product administered
Binding: Vaccine Administered Value Set (example)
... patient S1..1Reference(DAF-Patient)Who was immunized?
... wasNotGiven ?! I1..1booleanFlag for whether immunization was given
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... reported S1..1booleanIs this a self-reported record?
... performer S0..1Reference(U.S. Data Access Framework (DAF) Practitioner Profile | U.S. DAF Organization Profile)Who administered vaccine?
... requester S0..1Reference(U.S. Data Access Framework (DAF) Practitioner Profile | U.S. DAF Organization Profile)Who ordered vaccination?
... encounter 0..1Reference(U.S. Data Access Framework (DAF) Encounter profile)Encounter administered as part of
... manufacturer S0..1Reference(U.S. DAF Organization Profile)Vaccine Manufacturer
... location 0..1Reference(Location)Where did vaccination occur?
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Medication Route FDA Value Set (preferred)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration / non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen did reaction start?
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported S0..1booleanWas reaction self-reported?
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntWhat dose number within series?
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(U.S. DAF Organization Profile)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..1CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose TargetCodes (example)
.... doseStatus S1..1CodeableConceptDoes dose count towards immunity?
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy does does count/not count?
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.9.1.2 Terminology Bindings

PathNameConformanceValueSet
Immunization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Immunization.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
Immunization.vaccineCodeVaccine Administered Value SetexampleVaccine Administered Value Set
Immunization.siteVaccine Administered Body SitepreferredVaccine Administered Body Site
Immunization.routeMedication Route FDA Value SetpreferredMedication Route FDA Value Set
Immunization.explanation.reasonImmunization Reason CodesexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenImmunization Reasons for Not Immunizing CodesexampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.targetDiseaseVaccination Protocol Dose TargetCodesexampleVaccination Protocol Dose TargetCodes
Immunization.vaccinationProtocol.doseStatusVaccination Protocol Dose Status codesexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonVaccination Protocol Dose Status Reason codesexampleVaccination Protocol Dose Status Reason codes

D.9.1.3 Constraints

IdPathDetailsRequirements
imm-2Immunization.wasNotGivenIf immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
XPath: not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))
imm-1Immunization.wasNotGivenIf immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
XPath: not(f:wasNotGiven/@value='true' and (count(f:reaction) > 0 or exists(f:explanation/reason)))
.